Docs
get https://gateway.iugu.com/api/v1/transactions/show/{payment_id}

Obter detalhes do pagamento

Recupera detalhes de um pagamento específico.

  • Com local preenchido, retorna o pagamento registrado no Gateway no formato payment_response.
  • Sem local, consulta o pagamento diretamente no adquirente e retorna a resposta do adquirente, cujo formato varia por adquirente.

Sem ações implementadas definidas

Request

Path variables

payment_id

Required

Type: string

ID do pagamento a ser consultado

Query params

local

Type: string

Qualquer valor não vazio retorna o pagamento registrado no Gateway (`payment_response`) em vez de consultar o adquirente

Ex: true

Headers

Workspace-Id

Type: string

ID do workspace. Quando ausente, é usado o workspace padrão do Gateway.

Ex: 1D81KhKbYuVq9505Bz4Nk9

Response

200

Detalhes do pagamento recuperados com sucesso

Example
1
"<SCHEMA>"

401

Não autorizado - Token de autenticação inválido ou ausente

message
String
Enum: `Requires authentication`, `Bad credentials`

Example
1
2
3
{
  "message": "<MESSAGE>"
}

404

`payment_not_found`: Pagamento não encontrado

error
String

Tipo do erro

Ex: payment_not_found

service
String

Nome do serviço que gerou o erro

Ex: Acquirers::CancelService

details
Object

Detalhes adicionais (estrutura varia por tipo de erro)

Example
1
2
3
4
5
6
{
  "error": "payment_not_found",
  "service": "Acquirers::CancelService",
  "details": {
  }
}

500

Erro interno. Possíveis causas (consulta no adquirente): - `authorization_transaction_not_found`: o pagamento não possui transação de autorização bem-sucedida - `bad_request`: o adquirente rejeitou a consulta - `invalid_acquirer`: adquirente não suportado

error
String

Tipo do erro

Ex: payment_not_found

service
String

Nome do serviço que gerou o erro

Ex: Acquirers::CancelService

details
Object

Detalhes adicionais (estrutura varia por tipo de erro)

Example
1
2
3
4
5
6
{
  "error": "payment_not_found",
  "service": "Acquirers::CancelService",
  "details": {
  }
}